HuasoFoundries / backgrid_es6

  backgrid

  http://github.com/wyuenho/backgrid

  Copyright (c) 2013 Jimmy Yuen Ho Wong and contributors

  Licensed under the MIT license.

*/

describe("A CellEditor", function () {

  it("calls postRender when model triggers 'backgrid:editing'", function () {

    var postRenderCalled = 0;

    var editor = new(Backgrid.CellEditor.extend({

      postRender: function () {

        postRenderCalled++;

      }

    }))({

      formatter: {

        fromRaw: function () {},

        toRaw: function () {}

      },

      column: {

        name: "name",

        cell: "string"

      },

      model: new Backbone.Model({

        name: "alice"

      })

    });

    editor.render();

    editor.model.trigger("backgrid:editing");

    expect(postRenderCalled).toBe(1);

  });

});

describe("An InputCellEditor", function () {

  var book;

  var editor;

  var backgridEditedTriggerCount;

  var backgridEditedTriggerArgs;

  var backgridErrorTriggerCount;

  var backgridErrorTriggerArgs;

  beforeEach(function () {

    book = new Backbone.Model({

      title: "title"

    });

    editor = new(Backgrid.InputCellEditor.extend({

      remove: jasmine.createSpy("remove")

    }))({

      model: book,

      column: new Backgrid.Column({

        name: "title",

        cell: Backgrid.StringCell

      }),

      formatter: new Backgrid.StringCell.prototype.formatter(),

      placeholder: "put your text here"

    });

    backgridEditedTriggerCount = 0;

    book.on("backgrid:edited", function () {

      backgridEditedTriggerCount++;

      backgridEditedTriggerArgs = [].slice.call(arguments);

    });

    backgridErrorTriggerCount = 0;

    book.on("backgrid:error", function () {

      backgridErrorTriggerCount++;

      backgridErrorTriggerArgs = [].slice.call(arguments);

    });

    jasmine.addMatchers({

      toBeAnInstanceOf: function (util) {

        return {

          compare: function (actual, expected) {

            return {

              pass: actual instanceof expected

            };

          },

          negativeCompare: function (actual, expected) {

            return !this.compare(actual, expected)

          }

        };

      }

    });

  });

  it("renders a text input box with a placeholder and the model value formatted for display", function () {

    editor.render();

    expect(editor.el).toBeAnInstanceOf(HTMLInputElement);

    expect(editor.$el.attr("placeholder")).toBe("put your text here");

    expect(editor.$el.val()).toBe("title");

  });

  it("saves a formatted value in the input box to the model and triggers 'backgrid:edited' from the model when tab is pressed", function () {

    editor.render();

    editor.$el.val("another title");

    var tab = $.Event("keydown", {

      keyCode: 9

    });

    editor.$el.trigger(tab);

    expect(editor.model.get(editor.column.get("name"))).toBe("another title");

    expect(backgridEditedTriggerCount).toBe(1);

    expect(backgridEditedTriggerArgs[0]).toEqual(editor.model);

    expect(backgridEditedTriggerArgs[1]).toEqual(editor.column);

    expect(backgridEditedTriggerArgs[2].moveRight()).toBe(true);

  });

  it("saves a formatted value in the input box to the model and triggers 'backgrid:edited' from the model when enter is pressed", function () {

    editor.render();

    editor.$el.val("another title");

    var enter = $.Event("keydown", {

      keyCode: 13

    });

    editor.$el.trigger(enter);

    expect(editor.model.get(editor.column.get("name"))).toBe("another title");

    expect(backgridEditedTriggerCount).toBe(1);

    expect(backgridEditedTriggerArgs[0]).toEqual(editor.model);

    expect(backgridEditedTriggerArgs[1]).toEqual(editor.column);

    expect(backgridEditedTriggerArgs[2].save()).toBe(true);

  });

  it("triggers 'backgrid:error' from the model when trying to save an invalid value", function () {

    editor.formatter = {

      fromRaw: jasmine.createSpy("fromRaw").and.callFake(function (d) {

        return d;

      }),

      toRaw: jasmine.createSpy("toRaw").and.returnValue(undefined)

    };

    editor.render();

    editor.$el.val("invalid value");

    var enter = $.Event("keydown", {

      keyCode: 13

    });

    editor.$el.trigger(enter);

    expect(editor.formatter.toRaw.calls.count()).toBe(1);

    expect(editor.formatter.toRaw).toHaveBeenCalledWith("invalid value", editor.model);

    expect(backgridErrorTriggerCount).toBe(1);

    expect(backgridErrorTriggerArgs[0]).toEqual(editor.model);

    expect(backgridErrorTriggerArgs[1]).toEqual(editor.column);

    expect(backgridErrorTriggerArgs[2]).toEqual("invalid value");

    editor.formatter.toRaw.calls.reset();

    editor.$el.blur();

    expect(backgridErrorTriggerCount).toBe(2);

    expect(backgridErrorTriggerArgs[0]).toEqual(editor.model);

    expect(backgridErrorTriggerArgs[1]).toEqual(editor.column);

    expect(backgridErrorTriggerArgs[2]).toEqual("invalid value");

  });

  it("discards changes and triggers 'backgrid:edited' from the model when esc is pressed'", function () {

    editor.render();

    editor.$el.val("new value");

    var esc = $.Event("keydown", {

      keyCode: 27

    });

    editor.$el.trigger(esc);

    expect(backgridEditedTriggerCount).toBe(1);

    expect(backgridEditedTriggerArgs[0]).toEqual(editor.model);

    expect(backgridEditedTriggerArgs[1]).toEqual(editor.column);

    expect(backgridEditedTriggerArgs[2].cancel()).toBe(true);

    expect(editor.model.get(editor.column.get("name"))).toBe("title");

  });

  it("triggers 'backgrid:edited' from the model when value hasn't changed and focus is lost", function () {

    editor.render();

    editor.$el.blur();

    expect(backgridEditedTriggerCount).toBe(1);

    expect(backgridEditedTriggerArgs[0]).toEqual(editor.model);

    expect(backgridEditedTriggerArgs[1]).toEqual(editor.column);

    expect(backgridEditedTriggerArgs[2].passThru()).toBe(true);

    expect(editor.model.get(editor.column.get("name"))).toBe("title");

  });

  it("saves the value if the value is valid when going out of focus", function () {

    editor.render();

    editor.$el.val("another title");

    editor.$el.blur();

    expect(backgridEditedTriggerCount).toBe(1);

    expect(backgridEditedTriggerArgs[0]).toEqual(editor.model);

    expect(backgridEditedTriggerArgs[1]).toEqual(editor.column);

    expect(backgridEditedTriggerArgs[2].passThru()).toBe(true);

    expect(editor.model.get(editor.column.get("name"))).toBe("another title");

  });

});

describe("A Cell", function () {

  var book;

  var column;

  var cell;

  beforeEach(function () {

    book = new Backbone.Model({

      title: "title"

    });

    column = {

      name: "title",

      cell: "string"

    };

    cell = new Backgrid.Cell({

      model: book,

      column: column

    });

  });

  it("uses the formatter from the column if one is given", function () {

    var formatter = {

      fromRaw: function (rawValue) {

        return rawValue;

      },

      toRaw: function (formattedValue) {

        return formattedValue;

      }

    };

    column = {

      name: "title",

      cell: "string",

      formatter: formatter

    };

    cell = new Backgrid.Cell({

      model: book,

      column: column

    });

    expect(cell.formatter).toBe(formatter);

  });

  it("adds an editable, sortable and a renderable class to the cell if these column attributes are true", function () {

    column = {

      name: "title",

      cell: "string"

    };

    cell = new Backgrid.Cell({

      model: book,

      column: column

    });

    expect(cell.$el.hasClass("editable")).toBe(true);

    expect(cell.$el.hasClass("sortable")).toBe(true);

    expect(cell.$el.hasClass("renderable")).toBe(true);

    cell.column.set("editable", false);

    expect(cell.$el.hasClass("editable")).toBe(false);

    cell.column.set("sortable", false);

    expect(cell.$el.hasClass("sortable")).toBe(false);

    cell.column.set("renderable", false);

    expect(cell.$el.hasClass("renderable")).toBe(false);

    var TrueCol = Backgrid.Column.extend({

      mySortable: function () {

        return true;

      },

      myRenderable: function () {

        return true;

      },

      myEditable: function () {

        return true;

      }

    });

    var FalseCol = Backgrid.Column.extend({

      mySortable: function () {

        return false;

      },

      myRenderable: function () {

        return false;

      },

      myEditable: function () {

        return false;

      }

    });

    column = new TrueCol({

      name: "title",

      cell: "string",

      sortable: "mySortable",

      renderable: "myRenderable",

      editable: "myEditable"

    });

    cell = new Backgrid.Cell({

      model: book,

      column: column

    });

    expect(cell.$el.hasClass("editable")).toBe(true);

    expect(cell.$el.hasClass("sortable")).toBe(true);

    expect(cell.$el.hasClass("renderable")).toBe(true);

    column = new FalseCol({

      name: "title",

      cell: "string",

      sortable: "mySortable",

      renderable: "myRenderable",

      editable: "myEditable"

    });

    cell = new Backgrid.Cell({

      model: book,

      column: column

    });

    expect(cell.$el.hasClass("editable")).toBe(false);

    expect(cell.$el.hasClass("sortable")).toBe(false);

    expect(cell.$el.hasClass("renderable")).toBe(false);

    column = new Backgrid.Column({

      name: "title",

      cell: "string",

      sortable: function () {

        return true;

      },

      editable: function () {

        return true;

      },

      renderable: function () {

        return true;

      }

    });

    cell = new Backgrid.Cell({

      model: book,

      column: column

    });

    expect(cell.$el.hasClass("editable")).toBe(true);

    expect(cell.$el.hasClass("sortable")).toBe(true);

    expect(cell.$el.hasClass("renderable")).toBe(true);

  });

  it("renders a td with the model value formatted for display", function () {

    cell.render();

    expect(cell.$el.text()).toBe("title");

  });

  it("#472 updates editable, sortable, and renderable when rerendering", function () {

    function starable(model) {

      return model.get("title") == "Alice in Wonderland";

    }

    var TestCol = Backgrid.Column.extend({

      mySortable: starable,

      myRenderable: starable,

      mySortable: starable

    });

    column = new TestCol({

      name: "title",

      cell: "string",

      editable: "myEditable",

      renderable: "myRenderable",

      sortable: "mySortable"

    });

    cell = new Backgrid.Cell({

      model: book,

      column: column

    });

    cell.render();

    book.set("title", "Alice in Wonderland");

    expect(cell.$el.hasClass("editable")).toBe(true);

    expect(cell.$el.hasClass("sortable")).toBe(true);

    expect(cell.$el.hasClass("renderable")).toBe(true);

    book.set("title", "Oliver Twist");

    expect(cell.$el.hasClass("editable")).toBe(false);

    expect(cell.$el.hasClass("sortable")).toBe(false);

    expect(cell.$el.hasClass("renderable")).toBe(false);

  });

  it("goes into edit mode on click", function () {

    cell.render();

    cell.$el.click();

    expect(cell.$el.hasClass("editor")).toBe(true);

  });

  it("goes into edit mode when `enterEditMode` is called", function () {

    cell.render();

    cell.enterEditMode();

    expect(cell.$el.hasClass("editor")).toBe(true);

  });

  it("goes back into display mode when `exitEditMode` is called", function () {

    cell.render();

    cell.$el.click();

    cell.exitEditMode();

    expect(cell.$el.hasClass("editor")).toBe(false);

    expect(cell.$el.text()).toBe("title");

  });

  it("renders error when the editor triggers 'backgrid:error'", function () {

    cell.formatter = {

      fromRaw: function () {},

      toRaw: function () {}

    };

    cell.render();

    cell.$el.click();

    var editor = cell.currentEditor;

    editor.$el.val(undefined);

    var enter = $.Event("keydown", {

      keyCode: 13

    });

    editor.$el.trigger(enter);

    expect(cell.$el.hasClass("error")).toBe(true);

    expect(cell.$el.hasClass("editor")).toBe(true);

  });

  it("removes the editor correctly when removing the cell", function () {

    cell.render();

    cell.$el.click();

    var editor = cell.currentEditor;

    spyOn(editor, "remove");

    cell.remove("argument1", "argument2");

    expect(editor.remove).toHaveBeenCalledWith("argument1", "argument2");

  });

  describe("when the model value has changed", function () {

    it("refreshes during display mode", function () {

      cell.render();

      book.set("title", "another title");

      expect(cell.$el.text()).toBe("another title");

    });

    it("does not refresh during display mode if the change was silenced", function () {

      cell.render();

      book.set("title", "another title", {

        silent: true

      });

      expect(cell.$el.text()).toBe("title");

    });

    it("does not refresh during edit mode", function () {

      cell.render();

      cell.$el.click();

      book.set("title", "another title");

      expect(cell.$el.find("input[type=text]").val(), "title");

    });

  });

});

describe("A StringCell", function () {

  it("applies a string-cell class to the cell", function () {

    var book = new Backbone.Model({

      title: "<title>"

    });

    var column = {

      name: "title",

      cell: "string"

    };

    var cell = new Backgrid.StringCell({

      model: book,

      column: column

    });

    cell.render();

    expect(cell.$el.hasClass("string-cell")).toBe(true);

  });

});

describe("A UriCell", function () {

  var model;

  var column;

  var cell;

  beforeEach(function () {

    model = new Backbone.Model({

      url: "http://www.example.com"

    });

    column = {

      name: "url",

      cell: "uri"

    };

    cell = new Backgrid.UriCell({

      model: model,

      column: column

    });

  });

  it("applies a uri-cell class to the cell", function () {

    cell.render();

    expect(cell.$el.hasClass("uri-cell")).toBe(true);

  });

  it("renders the model value in an anchor", function () {

    cell.render();

    expect(cell.$el.find("a").attr("href")).toBe("http://www.example.com");

    expect(cell.$el.find("a").text()).toBe("http://www.example.com");

  });

  it("uses the supplied target or _blank", function () {

    cell.render();

    expect(cell.$el.find("a").attr("target")).toBe("_blank");

    cell = new Backgrid.UriCell({

      model: model,

      column: column,

      target: "_self"

    });

    cell.render();

    expect(cell.$el.find("a").attr("target")).toBe("_self");

  });

  it("uses the supplied title or the raw value", function () {

    cell.render();

    expect(cell.$el.find("a").attr("title")).toBe("http://www.example.com");

    cell = new Backgrid.UriCell({

      model: model,

      column: column,

      title: "http://backgridjs.com"

    });

    cell.render();

    expect(cell.$el.find("a").attr("title")).toBe("http://backgridjs.com");

  });

});

describe("An EmailCell", function () {

  var model;

  var column;

  var cell;

  beforeEach(function () {

    model = new Backbone.Model({

      email: "email@host"

    });

    column = {

      name: "email",

      cell: "email"

    };

    cell = new Backgrid.EmailCell({

      model: model,

      column: column

    });

  });

  it("applies a email-cell class to the cell", function () {

    expect(cell.render().$el.hasClass("email-cell")).toBe(true);

  });

  it("renders the model value in a mailto: anchor", function () {

    cell.render();

    expect(cell.$el.find("a").attr("href")).toBe("mailto:email@host");

    expect(cell.$el.find("a").text()).toBe("email@host");

  });

});

describe("A NumberCell", function () {

  it("accepts a formatter instance", function () {

    var formatter = {

      fromRaw: function (rawValue) {

        return rawValue;

      },

      toRaw: function (formattedValue) {

        return +formattedValue;

      }

    };

    var cell = new Backgrid.NumberCell({

      model: new Backbone.Model({

        age: 1.1

      }),

      column: {

        name: "age",

        cell: "number",

        formatter: formatter

      },

    });

    expect(cell.formatter).toBe(formatter);

  });

  it("applies a number-cell class to the cell", function () {

    var cell = new Backgrid.NumberCell({

      model: new Backbone.Model({

        age: 1.1

      }),

      column: {

        name: "age",

        cell: "number"

      }

    });

    cell.render();

    expect(cell.$el.hasClass("number-cell")).toBe(true);

  });

});

describe("An IntegerCell", function () {

  var cell;

  beforeEach(function () {

    cell = new Backgrid.IntegerCell({

      model: new Backbone.Model({

        age: 1

      }),

      column: {

        name: "age",

        cell: "integer"

      }

    });

  });

  it("applies an integer-cell class to the cell", function () {

    cell.render();

    expect(cell.$el.hasClass("integer-cell")).toBe(true);

  });

  it("will render a number with no trailing decimals numbers", function () {

    cell.model.set("age", 1.1);

    cell.render();

    expect(cell.$el.text()).toBe("1");

  });

  it("can be extended and it's defaults overidden", function () {

    var PlainIntegerCell = Backgrid.IntegerCell.extend({

      orderSeparator: ''

    });

    var cell = new PlainIntegerCell({

      model: new Backbone.Model({

        age: 1000

      }),

      column: {

        name: "age",

        cell: PlainIntegerCell

      }

    });

    cell.render();

    expect(cell.$el.text()).toBe("1000");

  });

});

describe("A PercentCell", function () {

  var cell;

  beforeEach(function () {

    cell = new Backgrid.PercentCell({

      model: new Backbone.Model({

        rate: 99.8

      }),

      column: {

        name: "rate",

        cell: "percent"

      }

    });

  });

  it("applies an percent-cell class to the cell", function () {

    cell.render();

    expect(cell.$el.hasClass("percent-cell")).toBe(true);

  });

  it("will render a percentage string", function () {

    cell.render();

    expect(cell.$el.text()).toBe("99.80%");

  });

  it("can be extended and it's defaults overidden", function () {

    var MyPercentCell = Backgrid.PercentCell.extend({

      orderSeparator: '',

      symbol: "pct",

      multiplier: 100

    });

    var cell = new MyPercentCell({

      model: new Backbone.Model({

        rate: 10.99

      }),

      column: {

        name: "rate",

        cell: MyPercentCell

      }

    });

    cell.render();

    expect(cell.$el.text()).toBe("1099.00pct");

  });

});

describe("A DatetimeCell", function () {

  var model;

  var column;

  var cell;

  beforeEach(function () {

    model = new Backbone.Model({

      datetime: "2000-01-01T00:00:00.000Z"

    });

    column = {

      name: "datetime",

      cell: "datetime"

    };

    cell = new Backgrid.DatetimeCell({

      model: model,

      column: column

    });

  });

  it("accepts a formatter instance", function () {

    var formatter = {

      fromRaw: function (rawValue) {

        return rawValue;

      },

      toRaw: function (formattedValue) {

        return formattedValue;

      }

    };

    cell = new Backgrid.DatetimeCell({

      model: model,

      column: _.extend({}, column, {

        formatter: formatter

      })

    });

    expect(cell.formatter).toBe(formatter);

  });

  it("applies a datetime-cell class to the cell", function () {

    cell.render();

    expect(cell.$el.hasClass("datetime-cell")).toBe(true);

  });

  it("renders a placeholder for different datetime formats for the editor according to configuration", function () {

    cell = new Backgrid.DatetimeCell({

      model: model,

      column: column

    });

    expect(cell.editor.prototype.attributes.placeholder).toBe("YYYY-MM-DDTHH:mm:ss");

    cell = new(Backgrid.DatetimeCell.extend({

      includeTime: false

    }))({

      model: model,

      column: column

    });

    expect(cell.editor.prototype.attributes.placeholder).toBe("YYYY-MM-DD");

    cell = new(Backgrid.DatetimeCell.extend({

      includeDate: false

    }))({

      model: model,

      column: column

    });

    expect(cell.editor.prototype.attributes.placeholder).toBe("HH:mm:ss");

    cell = new(Backgrid.DatetimeCell.extend({

      includeDate: false,

      includeMilli: true

    }))({

      model: model,

      column: column

    });

    expect(cell.editor.prototype.attributes.placeholder).toBe("HH:mm:ss.SSS");

    cell = new(Backgrid.DatetimeCell.extend({

      includeMilli: true

    }))({

      model: model,

      column: column

    });

    expect(cell.editor.prototype.attributes.placeholder).toBe("YYYY-MM-DDTHH:mm:ss.SSS");

  });

  it("is blank when the date value is null", function () {

    cell = new(Backgrid.DatetimeCell.extend({

      includeMilli: true

    }))({

      model: new Backbone.Model({

        datetime: null

      }),

      column: column

    });

    expect(cell.$el.html()).toBe('');

  });

});

describe("A DateCell", function () {

  var cell;

  beforeEach(function () {

    cell = new Backgrid.DateCell({

      model: new Backbone.Model({

        date: "2000-01-01"

      }),

      column: {

        name: "date",

        cell: "date"

      }

    });

  });

  it("applies a date-cell class to the cell", function () {

    cell.render();

    expect(cell.$el.hasClass("date-cell")).toBe(true);

  });

  it("will render a date with no time", function () {

    cell.model.set("date", "2000-01-01T00:00:00.000Z");

    cell.render();

    expect(cell.$el.text()).toBe("2000-01-01");

  });

});

describe("A TimeCell", function () {

  var cell;

  beforeEach(function () {

    cell = new Backgrid.TimeCell({

      model: new Backbone.Model({

        time: "00:00:00"

      }),

      column: {

        name: "time",

        cell: "time"

      }

    });

  });

  it("applies a time-cell class to the cell", function () {

    cell.render();

    expect(cell.$el.hasClass("time-cell")).toBe(true);

  });

  it("will render a time with no date", function () {

    cell.model.set("date", "2000-01-01T00:00:00.000Z");

    cell.render();

    expect(cell.$el.text()).toBe("00:00:00");

  });

});

describe("A SelectCellEditor", function () {

  var optionValues;

  var optionGroupValues;

  beforeEach(function () {

    optionValues = [

      ["Boy", 1],

      ["Girl", 2]

    ];

    optionGroupValues = [{

      "name": "\" ><script></script>Fruit",

      "values": [

        ["Apple<script></script>", "\" ><script></script>a"],

        ["Banana", "b"],

        ["Cantaloupe", "c"]

      ]

    }, {

      "name": "Cereal",

      "values": [

        ["Wheat", "w"],

        ["Rice", "r"],

        ["Maize", "m"]

      ]

    }];

  });

  it("renders a select box using a list if nvps", function () {

    // single selection

    var editor = new Backgrid.SelectCellEditor({

      formatter: new Backgrid.SelectFormatter(),

      column: {

        name: "gender",

        cell: "select"

      },

      model: new Backbone.Model({

        gender: 2

      })

    });

    editor.setOptionValues(optionValues);

    editor.render();

    expect(editor.el.tagName).toBe("SELECT");

    var $options = editor.$el.children();

    expect($options.length).toBe(2);

    expect($options.eq(0).val()).toBe("1");

    expect($options.eq(0).prop("selected")).toBe(false);

    expect($options.eq(0).text()).toBe("Boy");

    expect($options.eq(1).val()).toBe("2");

    expect($options.eq(1).prop("selected")).toBe(true);

    expect($options.eq(1).text()).toBe("Girl");

    // multiple selection

    var editor = new Backgrid.SelectCellEditor({

      formatter: new Backgrid.SelectFormatter(),

      column: {

        name: "gender",

        cell: "select"

      },

      model: new Backbone.Model({

        gender: [1, 2]

      })

    });

    editor.setMultiple(true);

    editor.setOptionValues(optionValues);

    editor.render();

    expect(editor.el.tagName).toBe("SELECT");

    expect(editor.el.multiple).toBe(true);

    var $options = editor.$el.children();

    expect($options.length).toBe(2);

    expect($options.eq(0).val()).toBe("1");

    expect($options.eq(0).prop("selected")).toBe(true);

    expect($options.eq(0).text()).toBe("Boy");

    expect($options.eq(1).val()).toBe("2");

    expect($options.eq(1).prop("selected")).toBe(true);

    expect($options.eq(1).text()).toBe("Girl");

  });

  it("renders a select box using a parameter-less function that returns a list if nvps", function () {

    // single selection

    var editor = new Backgrid.SelectCellEditor({

      formatter: new Backgrid.SelectFormatter(),

      column: {

        name: "gender",

        cell: "select"

      },